Prizm Content Connect
Document Annotation

This XML schema defines the annotation format used by Prizm Content Connect.

Elements and Attributes

The following elements are supported by the schema:

Element

Description

documentAnnotations

Root element of the annotations file

pages

Document pages for which markup was created

highlights

Redaction highlights

page

Individual annotation page with markups

annotation

Individual annotation markup on the page

redaction

Individual redaction representing highlighted text

The following sections describe the structure and the attributes supported by the elements:

documentAnnotations

Tag

Type

Description

pages [0..1]

Element

Array of document pages for which markup was created

highlights [0..1]

Element

Array of redactions

savedTime

Attribute

Save time for xml file (Optional)

savedDate

Attribute

Save date for xml file (Optional)

pages

Tag

Type

Description

page [1..*]

Element

Array of annotation pages

highlights

Tag

Type

Description

redaction [0..1]

Element

Array of redactions

page

Tag

Type

Description

annotation [1..*]

Element

Array of annotations

id

Attribute

Page number

annotation

Tag

Type

Description

y_percent

Attribute

Y coordinate of the markup in percentage with respect to page size (Optional)

y

Attribute

Y coordinate of the markup (Required)

x_percent

Attribute

X coordinate of the markup in percentage with respect to page size (Optional)

x

Attribute

X coordinate of the markup (Required)

width_percent

Attribute

Width Percentage of the markup with respect to page size (Optional)

width

Attribute

Width of the markup in pixels (Required)

stampSize

Attribute

Size of the stamp in pixels. Used when drawType=stamp_redact. (Optional, default = 20)

lineWidth

Attribute

The width of the line around the markup (Optional, default = 1)

lineColor

Attribute

The color of the line around the markup. Used when drawType=rectangle_filled_redact or drawType=rectangle_trans_redact.  (Optional, default 0 for rectangle_filled_redact, FFFF00 for rectangle_trans_redact)

angle

Attribute

Reserved for future use (Optional)

height_percent

Attribute

Height Percentage of the markup with respect to page size (Optional)

height

Attribute

Height of the markup in pixels (Required)

fillColor

Attribute

The fill color of the line around the markup. Used when drawType=rectangle_filled_redact or drawType=rectangle_trans_redact.  (Optional, default 0 for rectangle_filled_redact, FFFF00 for rectangle_trans_redact)

drawType

Attribute

Type of markup (Required)

 

rectangle_filled_redact: draws the black rectangle

rectangle_trans_redact: draws the yellow transparent rectangle

stamp_redact: draws the stamp

text_redact: draws the text

eSignText: reserved for future use

eSignName: eSignature person last name

eSignTitle: eSignature person title

eSignEmail: eSignature person email

eSignDate: eSignature date

eSignInitials: eSignature person initials

eSignSignature: eSignature person signature, such as full name

eSignESignId: used for printing eSignature signing id

dragDirection

Attribute

The drag direction of the rectangle (Optional, reserved for future use)

meta

Attribute

Meta data for the markup (Optional)

label

Attribute

Label for the markup (Optional)

nodeId

Attribute

Reserved for future use (Optional)

saveDate

Attribute

Save date for markup (Optional)

saveTime

Attribute

Save time for markup (Optional)

uuid

Attribute

eSign UUID parameter value (Optional)

formUser

Attribute

Reserved for future use (Optional)

created

Attribute

Annotation creation timestamp (Optional)

modified

Attribute

Annotation modified timestamp (Optional)

redaction

Tag

Type

Description

userid

Attribute

User Id. Used by Flash client user interface. (Optional)

tooltip

Attribute

Tooltip text. Used by Flash client user interface. (Optional)

start

Attribute

Starting pointer. Used by Flash client user interface. (Optional, default=0)

page

Attribute

Page number. Used by Flash client user interface. (Optional, default=0)

occurance

Attribute

Number of text occurrences. Used by Flash client user interface. (Optional, default=0)

mode

Attribute

Searching mode for highlights. Used by Flash client user interface. (Optional)

id

Attribute

Highlighting ID string. Used by Flash client user interface. (Required)

end

Attribute

Ending pointer. Used by Flash client user interface. (Optional, default=0)

documentname

Attribute

Document name string. Used by Flash client user interface. (Optional)

color

Attribute

Highlighting color. Used by Flash client user interface. (Optional)

annotation

Attribute

Indicates if annotation flag is present. Used by Flash client user interface. (Required, Default=0, Value=0 or 1)

allowDelete

Attribute

Indicates if annotation can be deleted. Used by Flash client user interface. (Optional, Default=true, Value=false or true)

Example
Copy Code
+<xs:annotation>
<xs:documentation>Node containing the annotation for each page.</xs:documentation>
</xs:annotation>
-<xs:complexType>
-<xs:sequence>
<xs:elementmaxOccurs="unbounded"ref="page" />
</xs:sequence>
</xs:complexType>
</xs:element>

 

 


©2013. Accusoft Corporation. All Rights Reserved.

Send Feedback